| MCCI_HD002100CA Request Transport Wrapper |
(Link to Excel View) Derived from RMIM: MCCI_RM002100CA |
||||||||
| Message |
Design Comments: The root class of all messages. Rationale: Conveys information about the interaction and how it is to be processed |
||||||||
| id [1..1] (M) Message (II.TOKEN) |
Design Comments: A unique identifier for the message. UsageNotes: Test. Colin. Rationale: Allows detection of duplicate messages, and allows tying acknowledgments to the message they are acknowledging. The attribute is therefore mandatory. Mapping: soap:Header\wsa:MessageID |
||||||||
| creationTime [1..1] (M) Message (TS.FULLDATETIME) |
Design Comments: Indicates the time this particular message instance was constructed. Rationale: Allows identification of how current the information in a message is. Also provides a baseline for identifying the time-zone of other times within the message. As a result, the attribute is mandatory. |
||||||||
| securityText [0..1] Message (ST) {CNE:C:} |
Design Comments: A locally-defined field used to maintain a session, identify a user, and/or perform some other function related to authenticating the message source. Rationale: Allows jurisdictions and applications to communicate authentication and session information. The attribute is optional because not all jurisdictions will require this capability. |
||||||||
| responseModeCode [1..1] (M) Message (CS) {CNE:V:ResponseMode} |
Design Comments: Identifies whether the application level response is desired immediately (as a direct acknowledgement), on a deferred basis (as a subsequent independent interaction) or via queue using polling. Rationale: Essential to determining receiver behavior and therefore mandatory. Mapping: soap:Header\wsa:Action (after the second underscore, if any, “D” otherwise) |
||||||||
| versionCode [1..1] (M) Message (CS) {CNE:C:HL7StandardVersionCode:V3, fixed value= "V3"} |
Design Comments: Indicates the version of the messaging standard being referenced. Rationale: Needed to know how to validate message definition, CMET definition, vocabulary and other information and is therefore mandatory. Mapping: soap:Header\wsa:To\ (portion between last “\” and second-last “\”) |
||||||||
| interactionId [1..1] (M) Message (II.PUBLIC) |
Design Comments: Indicates the interaction conveyed by this message. Rationale: Identifies what the receiving application should do, and how the message should be validated. The attribute is therefore mandatory. Mapping: soap:Header\wsa:Action (after “urn:hl7-org:v3:” and before the second underscore, if any) |
||||||||
| profileId [1..10] (M) Message (LIST<II.BUS>) |
Design Comments: Identifies the conformance profile(s) this message complies with. Rationale: Indicates any additional validation that may be appropriate. Also influences what extensions can be processed. |
||||||||
| processingCode [1..1] (M) Message (CS) {CNE:V:ProcessingID} |
Design Comments: Indicates whether this message is intended to be processed as production, test or debug message. Rationale: Indicates how the message should be handled and is therefore mandatory. Mapping: soap:Header\wsa:To\(portion between second-last “\” and third-last “\”) |
||||||||
| processingModeCode [1..1] (M) Message (CS) {CNE:V:ProcessingMode} |
Design Comments: This attribute defines whether the message is being sent in current processing, archive mode, initial load mode, restore from archive mode Rationale: Describes the mode of processing. For example current processing, archive mode, initial load mode, restore from archive mode. |
||||||||
| acceptAckCode [1..1] (M) Message (CS) {CNE:V:AcknowledgementCondition} |
Design Comments: Indicates how the message is expected to be acknowledged. UsageNotes: When using SOAP, this attribute MUST be set to NE (Never). (Accept acknowledgements are handled via the transport protocol, not HL7.) Rationale: Provides support for immediate, deferred and polling mode and distinguishes which mode is desired. The attribute is therefore mandatory. |
||||||||
| receiver [1..1] (Receiver) | |||||||||
| respondTo [0..1] (RespondTo) |
Design Comments: Indicates the system that should receive the response to this interaction. Used when different from the sender of the original interaction. Rationale: In complex routing environments, the acknowledgements may need to be sent to a system other than the one which constructed the original message. This association is optional because not all environments will support responses to systems other than the original sender. |
||||||||
| sender [1..1] (Sender) | |||||||||
| attentionLine [0..5] (AttentionLine) |
Design Comments: Provides information on how the message should be routed within the receiving application. Rationale: Allows direction of messages within complex applications. This association is optional because not all applications will require this level of routing. |
||||||||
| controlActEvent [0..1] (Stub "ControlActEvent") | |||||||||
| Receiver | |||||||||
| typeCode [1..1] (M) CommunicationFunction (CS) {CNE:C:CommunicationFunctionType:RCV, fixed value= "RCV"} |
|||||||||
| telecom [0..1] CommunicationFunction (TEL.URI) |
Design Comments: The address to which this message is being sent. Rationale: Indicates where the message should be sent. This is optional because not all environments require network addresses. It is mandatory when communicating using SOAP. Mapping: soap:Header\wsa:To |
||||||||
| device [1..1] (Device2) | |||||||||
| Device2 | |||||||||
| classCode [1..1] (M) Device (CS) {CNE:C:EntityClass:DEV, fixed value= "DEV"} |
|||||||||
| determinerCode [1..1] (M) Device (CS) {CNE:C:EntityDeterminer:INSTANCE, fixed value= "INSTANCE"} |
|||||||||
| id [1..1] (M) Device (II.BUS) |
Design Comments: The unique identifier of the application to which the message is being sent. Rationale: Used for routing and for verification that "yes, this message is intended for me." This is mandatory because it is the key identifier of the receiving application. Mapping: soap:Header\wsa:To\@endpointID |
||||||||
| name [0..1] Device (ST) {CNE:C:} |
Design Comments: Name of the receiver application. Rationale: Optional name of the receiver application. |
||||||||
| agent [0..1] (Agent2) | |||||||||
| Agent2 | |||||||||
| classCode [1..1] (M) Role (CS) {CNE:C:RoleClass:AGNT, fixed value= "AGNT"} |
|||||||||
| agentOrganization [1..1] (Organization2) | |||||||||
| Organization2 | |||||||||
| classCode [1..1] (M) Organization (CS) {CNE:C:EntityClass:ORG, fixed value= "ORG"} |
|||||||||
| determinerCode [1..1] (M) Organization (CS) {CNE:C:EntityDeterminer:INSTANCE, fixed value= "INSTANCE"} |
|||||||||
| id [1..1] (M) Organization (II.BUS) |
Design Comments: Unique identifier for the receiver organization. Rationale: The identifier is the only non-structural attribute in this class and is therefore mandatory. The association from receiver device to agent is optional. |
||||||||
| RespondTo |
Design Comments: Indicates the system that should receive the response to this interaction. Used when different from the sender of the original interaction. Rationale: In complex routing environments, the acknowledgements may need to be sent to a system other than the one which constructed the original message. This association is optional because not all environments will support responses to systems other than the original sender. |
||||||||
| typeCode [1..1] (M) CommunicationFunction (CS) {CNE:C:CommunicationFunctionType:RSP, fixed value= "RSP"} |
|||||||||
| telecom [0..1] CommunicationFunction (TEL.URI) |
Design Comments: Indicates the address to send acknowledgments of this message to. Rationale: Needed when the address to respond to is different than that of the sender. This is optional because not all environments require network addresses. It is required when communicating using SOAP. Mapping: soap:Header\wsa:ReplyTo |
||||||||
| device [1..1] (Device3) |
Design Comments: The system to which responses are to be directed. Rationale: Provides support for directing responses to applications other than the original sender. |
||||||||
| Device3 |
Design Comments: The system to which responses are to be directed. Rationale: Provides support for directing responses to applications other than the original sender. |
||||||||
| classCode [1..1] (M) Device (CS) {CNE:C:EntityClass:DEV, fixed value= "DEV"} |
|||||||||
| determinerCode [1..1] (M) Device (CS) {CNE:C:EntityDeterminer:INSTANCE, fixed value= "INSTANCE"} |
|||||||||
| id [1..1] (M) Device (II.BUS) |
Design Comments: The unique identifier of the applications to which responses should be sent. Only populated when different from the sending application id. Rationale: Allows unique identification and routing to the application to be responded to. This attribute is mandatory be cause it is the principal identifier of the application to respond to. Mapping: soap:Header\wsa:ReplyTo\@endpointID |
||||||||
| Sender | |||||||||
| typeCode [1..1] (M) CommunicationFunction (CS) {CNE:C:CommunicationFunctionType:SND, fixed value= "SND"} |
|||||||||
| telecom [0..1] CommunicationFunction (TEL.URI) |
Design Comments: The network address of the application which sent the message. Rationale: May be important for sender validation. Usually also the address to which responses are sent. This is optional because not all environments require network addresses. It is mandatory when communicating using SOAP. Mapping: soap:Header\wsa:From |
||||||||
| device [1..1] (Device1) | |||||||||
| Device1 | |||||||||
| classCode [1..1] (M) Device (CS) {CNE:C:EntityClass:DEV, fixed value= "DEV"} |
|||||||||
| determinerCode [1..1] (M) Device (CS) {CNE:C:EntityDeterminer:INSTANCE, fixed value= "INSTANCE"} |
|||||||||
| id [1..1] (M) Device (II.BUS) |
Design Comments: The unique identifier of the application or system from which the message has originated. Rationale: Because this is the key identifier of where the message has originated, this attribute is mandatory in order to support efficient logging, auditing and debugging requirements. Mapping: soap:Header\wsa:From\@endpointID |
||||||||
| name [0..1] Device (ST) {CNE:C:} |
Design Comments: This is the name associated with the system or application sending the message. Rationale: Provides useful information when debugging. |
||||||||
| desc [0..1] Device (ST) {CNE:C:} |
Design Comments: Provides additional information about the configuration of the sending application. Useful when debugging. Rationale: Provides additional information that may assist in debugging interactions. |
||||||||
| existenceTime [0..1] Device (IVL.LOW<TS.FULLDATE>) |
Design Comments: Indicates the last time the sending application was modified or reconfigured. Rationale: Can help to isolate the source of a problem when debugging. |
||||||||
| manufacturerModelName [0..1] Device (ST) {CWE:D:ManufacturerModelName} |
Design Comments: Indicates the version number of the piece of software used to construct the message. Rationale: May be used to filter messages based on the compliance testing of the sending software. |
||||||||
| softwareName [0..1] Device (ST) {CWE:D:SoftwareName} |
Design Comments: Indicates the name of the software used to construct the message. Rationale: May be used to filter messages based on sending application compliance testing. |
||||||||
| agent [0..1] (Agent) | |||||||||
| Agent | |||||||||
| classCode [1..1] (M) Role (CS) {CNE:C:RoleClass:AGNT, fixed value= "AGNT"} |
|||||||||
| agentOrganization [1..1] (Organization) | |||||||||
| Organization | |||||||||
| classCode [1..1] (M) Organization (CS) {CNE:C:EntityClass:ORG, fixed value= "ORG"} |
|||||||||
| determinerCode [1..1] (M) Organization (CS) {CNE:C:EntityDeterminer:INSTANCE, fixed value= "INSTANCE"} |
|||||||||
| id [1..1] (M) Organization (II.BUS) |
Design Comments: Sending organization unique identifier. Rationale: The identifier is the only non-structural attribute in this class and is therefore mandatory. The association from sending device to agent is optional. |
||||||||
| AttentionLine |
Design Comments: Provides information on how the message should be routed within the receiving application. Rationale: Allows direction of messages within complex applications. This association is optional because not all applications will require this level of routing. |
||||||||
| keyWordText [1..1] (M) AttentionLine (ST) {CWE:D:AttentionKeyword} |
Design Comments: A particular type of guidance for routing the message. Rationale: Allows categorization of routing types or support for multiple route pieces. Mandatory to understand the routing information. |
||||||||
| value [0..1] AttentionLine (ST) {CWE:D:AttentionLineValue} |
Design Comments: Indicates the specific value used to route the item. Rationale: Allows internal routing within an application. |
||||||||